Modify Customer Product Instance
This API is used to modify an existing customer product instance attributes.
|
HTTP URL |
|
|---|---|
| PATCH | /api/v2/customer/{id}/product-instance/{id} |
Eligibility
The Requestor is eligible to modify a product instance attached to his sub-customers. It is not allowed to modify a product instance at any other hierarchy level.
API Request
Request Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
expirationDate |
Date |
O |
Determines the new requested expiration date of the instance per the chosen ‘expirationType’ while product creation. Can be used if the related product ‘expirationType’ is either FIXED or RELATIVE_ATTACHED. Reject if populated for ‘Not Expired’ type (empty value). |
API Response
Response Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
errorCode |
String |
O |
Failure code. See list below, under ‘Error Codes’ section. |
|
errorMessage |
String |
O |
Failure detailed description. See list below, under ‘Error Codes’ section. |
|
content |
Object |
O |
Array of main response body object displayed when an API call was successful. For a failure, it will be empty. |
|
pageable |
Object |
O |
Paging information object displayed when an API call was successful. For a failure, it will be empty. |
Content data objects
|
Element |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
requestId |
UUID |
M |
Request instance ID. To be used by external systems to query the call (operation) status, whether in progress, successful or failed. |
Pageable data objects
|
Element |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
page |
Numeric |
M |
Page number |
|
size |
Numeric |
M |
Page size. Number of requested elements per page |
|
totalPages |
Numeric |
M |
Total amount of available pages per requested page size |
|
totalElements |
Numeric |
M |
Total amount of retrieved elements |
Error Codes
In addition to the general success and failure codes, the following error codes are possible.
|
Code |
Message |
|---|---|
|
GLOBAL_1001 |
Service unavailable. Please try again |
|
CUSTOMER_1050 |
Failed to modify product instance |
|
AUTH_1016 |
Invalid product instance |
Examples
Request Body
{
"expirationDate": "09092025"
}Response Body: Success ACK
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}Response Body: Failure NAK
{
"errorCode": "CUSTOMER_1050",
"errorMessage": "Failed to modify product instance",
"content": "",
"pageable": null
}